<!doctype html>
<html lang="en">
<head>
    <title>API for class classDoc (phpAPI: PHP Documentation Creator version 6.0)</title>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
    <meta name="generator" content="phpAPI 6.0 (https://github.com/Greenray/phpAPI/)">
    <link rel="stylesheet" type="text/css" href="../style.css">
    <link rel="start" href="../index.html">
</head>
    <body id="classDoc" onload="parent.document.title=document.title;">
    <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../phpapi/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../phpapi/package-tree.html">phpapi\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    <hr />
<div class="package">Namespace phpapi</div>
<h1>Class classDoc</h1>
<div id="list">
    <ul>
        <li><a href="../phpapi/doc.html">doc</a><ul><li><a href="../phpapi/elementdoc.html">elementDoc</a><ul><li><strong>classDoc</strong></li></ul></li>
                        </ul></li>    </ul>
</div>
<hr />
<p class="arguments">public  class <strong>classDoc</strong> extends <a href="../phpapi/elementdoc.html">elementDoc</a></p>
<div class="comment" id="overview_description">Represents a PHP class and provides access to information about the class,<br /> class's comments and tags, and the members of the class.</div>
<div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Program</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">phpapi: PHP Documentation Creator</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Version</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">6.0</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Author</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Victor Nabatov greenray.spb@gmail.com</td>
                    </tr>
            <tr>
            <td class="hid left w_100">Copyright</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">(c) 2015-2016 Victor Nabatov</td>
                    </tr>
            <tr>
            <td class="hid left w_100">License</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">Creative Commons Attribution-ShareAlike 4.0 International</td>
                    </tr>
            <tr>
            <td class="hid left w_100">File</td>
            <td class="hid right w_100 lilac">&nbsp;</td>
                            <td class="hid" colspan="2">/system/classes/classDoc.php</td>
                    </tr>
        </table>
</div>
            <table class="inherit">
            <tr><th>Fields inherited from phpapi \ elementDoc</th></tr>
            <tr>
                <td>
                                    <span><a href="../phpapi/elementdoc.html#$access"><span class="green">$access, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$filename"><span class="green">$filename, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$final"><span class="green">$final, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$includes"><span class="green">$includes, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$lineNumber"><span class="green">$lineNumber, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$package"><span class="green">$package, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$parameters"><span class="green">$parameters, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$parent"><span class="green">$parent, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$sourcePath"><span class="green">$sourcePath, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$static"><span class="green">$static, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#$throws"><span class="green">$throws</span></a>&nbsp;</span>
                                </td>
            </tr>
        </table>
            <table class="inherit">
            <tr><th>Fields inherited from phpapi \ doc</th></tr>
            <tr>
                <td>
                                    <span><a href="../phpapi/doc.html#$data"><span class="green">$data, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$desc"><span class="green">$desc, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$docComment"><span class="green">$docComment, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$inBody"><span class="green">$inBody, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$name"><span class="green">$name, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$overview"><span class="green">$overview, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$root"><span class="green">$root, </span></a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#$tags"><span class="green">$tags</span></a>&nbsp;</span>
                                </td>
            </tr>
        </table>
                <table class="inherit">
            <tr><th>Methods inherited from phpapi \ elementDoc</th></tr>
            <tr>
                <td>
                                    <span><a href="../phpapi/elementdoc.html#construct">construct, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#arguments">arguments, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#containingClass">containingClass, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#containingPackage">containingPackage, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#fullNamespace">fullNamespace, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#location">location, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#modifiers">modifiers, </a>&nbsp;</span>
                                    <span><a href="../phpapi/elementdoc.html#path">path</a>&nbsp;</span>
                                </td>
            </tr>
        </table>
            <table class="inherit">
            <tr><th>Methods inherited from phpapi \ doc</th></tr>
            <tr>
                <td>
                                    <span><a href="../phpapi/doc.html#construct">construct, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isClass">isClass, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isConstructor">isConstructor, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isException">isException, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isField">isField, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isFunction">isFunction, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isGlobal">isGlobal, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isInterface">isInterface, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isMethod">isMethod, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isOrdinaryClass">isOrdinaryClass, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#isTrait">isTrait, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#mergeData">mergeData, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#set">set, </a>&nbsp;</span>
                                    <span><a href="../phpapi/doc.html#setByRef">setByRef</a>&nbsp;</span>
                                </td>
            </tr>
        </table>
        <h2 id="details_fields">Fields</h2>
            <div class="location">system/classes/classDoc.php at line 18</div>
        <pre class="arguments" id="abstract">public  boolean <strong><span class="green">$abstract</span></strong> = FALSE;</pre>
        <div class="details">Is this class abstract?</div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 21</div>
        <pre class="arguments" id="constants">public  <a href="../phpapi/fielddoc.html">fieldDoc</a> <strong><span class="green">$constants</span></strong> = [];</pre>
        <div class="details">Class constants</div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 24</div>
        <pre class="arguments" id="fields">public  <a href="../phpapi/fielddoc.html">fieldDoc</a> <strong><span class="green">$fields</span></strong> = [];</pre>
        <div class="details">Class fields</div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 27</div>
        <pre class="arguments" id="includes">public  array <strong><span class="green">$includes</span></strong> = [];</pre>
        <div class="details">Required files or files to be included</div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 30</div>
        <pre class="arguments" id="interface">public  boolean <strong><span class="green">$interface</span></strong> = FALSE;</pre>
        <div class="details">Is this an interface?</div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 33</div>
        <pre class="arguments" id="interfaces">public  <a href="../phpapi/classdoc.html">classDoc</a> <strong><span class="green">$interfaces</span></strong> = [];</pre>
        <div class="details">Interfaces this class implements or this interface extends</div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 36</div>
        <pre class="arguments" id="methods">public  <a href="../phpapi/methoddoc.html">methodDoc</a> <strong><span class="green">$methods</span></strong> = [];</pre>
        <div class="details">Class methods</div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 39</div>
        <pre class="arguments" id="superclass">public  string <strong><span class="green">$superclass</span></strong> = NULL;</pre>
        <div class="details">Super class</div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 42</div>
        <pre class="arguments" id="trait">public  boolean <strong><span class="green">$trait</span></strong> = FALSE;</pre>
        <div class="details">Is this a trait?</div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 45</div>
        <pre class="arguments" id="traits">public  <a href="../phpapi/classdoc.html">classDoc</a> <strong><span class="green">$traits</span></strong> = [];</pre>
        <div class="details">Traits this class uses</div>
        <hr />
        <h2 id="details_constructor">Constructor</h2>
    <div class="location">system/classes/classDoc.php at line 56</div>
    <code class="arguments" id="construct">public  void <strong>construct</strong>(<span class="lilac">string</span> <span class="blue">$name</span>, <a href="../phpapi/rootdoc.html">rootDoc</a> <span class="blue">&$root</span>, <span class="lilac">string</span> <span class="blue">$filename</span>, <span class="lilac">integer</span> <span class="blue">$lineNumber</span>, <span class="lilac">string</span> <span class="blue">$sourcePath</span>)</code>
    <div class="details">
            <p class="description">Constructor.</p>
        <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$name</td>
                <td class="hid">Name of element</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac"><a href="../phpapi/rootdoc.html">rootDoc</a></td>
                            <td class="hid blue w_100">&$root</td>
                <td class="hid">Object reference</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$filename</td>
                <td class="hid">Filename of the source file this element is in</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">integer</td>
                            <td class="hid blue w_100">$lineNumber</td>
                <td class="hid">Line number of the source file this element is at</td>
                    </tr>
            <tr>
            <td class="hid left w_100">&nbsp</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$sourcePath</td>
                <td class="hid">Source path containing the source file</td>
                    </tr>
        </table>
</div>
    </div>
    <h2 id="details_methods">Methods</h2>
            <div class="location">system/classes/classDoc.php at line 69</div>
        <code class="arguments" id="constructor">public  <a href="../phpapi/methoddoc.html">methodDoc</a> <strong>constructor</strong> ()</code>
        <div class="details">
                    <p class="description">Returns constructor for this class.</p>
                    </div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 85</div>
        <code class="arguments" id="destructor">public  <a href="../phpapi/methoddoc.html">methodDoc</a> <strong>destructor</strong> ()</code>
        <div class="details">
                    <p class="description">Returns destructor for this class.</p>
                    </div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 101</div>
        <code class="arguments" id="isClass">public  boolean <strong>isClass</strong> ()</code>
        <div class="details">
                    <p class="description">Returns TRUE if object is a class.</p>
                    </div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 110</div>
        <code class="arguments" id="isException">public  boolean <strong>isException</strong> ()</code>
        <div class="details">
                    <p class="description">Returns TRUE if object is an exception.</p>
                    </div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 119</div>
        <code class="arguments" id="isInterface">public  boolean <strong>isInterface</strong> ()</code>
        <div class="details">
                    <p class="description">Returns TRUE if this element is an interface.</p>
                    </div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 128</div>
        <code class="arguments" id="isOrdinaryClass">public  boolean <strong>isOrdinaryClass</strong> ()</code>
        <div class="details">
                    <p class="description">Constructs an ordinary class (not an interface or an exception).</p>
                    </div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 138</div>
        <code class="arguments" id="mergeSuperClassData">public  void <strong>mergeSuperClassData</strong> (<span class="lilac">string</span> <span class="blue">$superClassName</span>)</code>
        <div class="details">
                    <p class="description">Merges the details of the superclass with this class.<br /> This function is recursive.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">string</td>
                            <td class="hid blue w_100">$superClassName</td>
                <td class="hid">Name of the root class (default = NULL)</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 251</div>
        <code class="arguments" id="methods">public  <a href="../phpapi/methoddoc.html">methodDoc</a> <strong>methods</strong> (<span class="lilac">boolean</span> <span class="blue">$regularOnly</span>)</code>
        <div class="details">
                    <p class="description">Returns the array of methods in current class.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Parameters</td>
            <td class="hid right w_100 lilac">boolean</td>
                            <td class="hid blue w_100">$regularOnly</td>
                <td class="hid">Do not return constructors and destructors (default = FALSE)</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
            <div class="location">system/classes/classDoc.php at line 268</div>
        <code class="arguments" id="subclasses">public  array <strong>subclasses</strong> ()</code>
        <div class="details">
                    <p class="description">Returns the array of known subclasses of this class.</p>
            <div class="finfo">
    <table class="hid">
            <tr>
            <td class="hid left w_100">Return</td>
            <td class="hid right w_100 lilac">array</td>
                            <td class="hid" colspan="2">classDoc</td>
                    </tr>
        </table>
</div>
        </div>
        <hr />
        <div class="header">
    <span style="float:right">phpAPI v6.0</span>
            <ul>
                    <li><a href="../overview-summary.html">Overview</a></li>
                    <li><a href="../phpapi/package-summary.html">Namespace</a></li>
                    <li class="active">Class</li>
                    <li><a href="../phpapi/package-tree.html">phpapi\Tree</a></li>
                    <li><a href="../deprecated.html">Deprecated</a></li>
                    <li><a href="../todo.html">Todo</a></li>
                    <li><a href="../index-all.html">Index</a></li>
                </ul>
    </div>
<hr />
<div class="small_links">Frames: <a href="../index.html" target="_top"> On</a> | <a href="" target="_top"> Off</a></div>
<hr />
    <div class="small_links">
        <a href="#details_fields">Fields</a> | <a href="#details_methods">Methods</a> | <a href="#details_constructor">Constructor</a>
    </div>
    </body>
</html>
